[update] nullable Parameter For OpenApi3 by liverocaisson · Pull Request #739 · knuckleswtf/scribe

liverocaisson · 2023-10-02T02:17:36Z

If not required field
allow nullable parameter
as OpenAPI suggest

shalvah · 2023-10-02T09:27:12Z

You may need to update the test fixtures.

shalvah · 2023-11-19T19:45:46Z

I think you can update this now that #755 is merged.

jfoliveira · 2024-05-16T02:43:49Z

@liverocaisson nice one!
Could you merge this PR?
Exporting nullable: true for the nullable fields will be very useful! 🤞

liverocaisson · 2024-05-16T03:03:50Z

Would like to merge it but test fixtures dont pass. I don't know how to write scribe tests.

jfoliveira · 2024-05-16T16:29:27Z

I don't know how to write scribe tests.

@liverocaisson
I'm also not experienced with scribe code base, but I cloned your branch and made some local changes and tests seem to be passing now.

Could you apply the diffs below into your branch and update this PR?

1) File: `tests/Unit/OpenAPISpecWriterTest.php`

diff --git a/tests/Unit/OpenAPISpecWriterTest.php b/tests/Unit/OpenAPISpecWriterTest.php
index 41990675..7e6e77ce 100644
--- a/tests/Unit/OpenAPISpecWriterTest.php
+++ b/tests/Unit/OpenAPISpecWriterTest.php
@@ -234,6 +234,7 @@ class OpenAPISpecWriterTest extends TestCase
                 'type' => 'string',
                 'description' => 'A query param',
                 'example' => 'hahoho',
+                'nullable' => true,
             ],
         ], $results['paths']['/path1']['get']['parameters'][0]);
     }
@@ -341,6 +342,7 @@ class OpenAPISpecWriterTest extends TestCase
                                 'description' => 'String param',
                                 'example' => 'hahoho',
                                 'type' => 'string',
+                                'nullable' => true,
                             ],
                             'booleanParam' => [
                                 'description' => 'Boolean param',
@@ -361,8 +363,10 @@ class OpenAPISpecWriterTest extends TestCase
                                         'description' => 'Object param field',
                                         'example' => 119.0,
                                         'type' => 'number',
+                                        'nullable' => true,
                                     ],
                                 ],
+                                'nullable' => true,
                             ],
                         ],
                         'required' => [
@@ -384,11 +388,13 @@ class OpenAPISpecWriterTest extends TestCase
                                 'description' => 'File param',
                                 'type' => 'string',
                                 'format' => 'binary',
+                                'nullable' => true,
                             ],
                             'numberArrayParam' => [
                                 'description' => 'Number array param',
                                 'example' => [186.9],
                                 'type' => 'array',
+                                'nullable' => true,
                                 'items' => [
                                     'type' => 'number',
                                 ],
@@ -397,6 +403,7 @@ class OpenAPISpecWriterTest extends TestCase
                                 'description' => 'Object array param',
                                 'example' => [[]],

2) File: `tests/Fixtures/openapi.yaml`

diff --git a/tests/Fixtures/openapi.yaml b/tests/Fixtures/openapi.yaml
index 9ea3a135..e4bedbbd 100644
--- a/tests/Fixtures/openapi.yaml
+++ b/tests/Fixtures/openapi.yaml
@@ -125,6 +125,7 @@ paths:
                         type: string
                         description: 'The filters.'
                         example: consequatur
+                        nullable: true
                 -
                     in: query
                     name: url_encoded
@@ -135,6 +136,7 @@ paths:
                         type: string
                         description: 'Used for testing that URL parameters will be URL-encoded where needed.'
                         example: '+ []&='
+                        nullable: true
                 -
                     in: header
                     name: Custom-Header
@@ -192,6 +194,7 @@ paths:
                         type: string
                         description: ''
                         example: consequatur
+                        nullable: true
                 -
                     in: header
                     name: Custom-Header
@@ -283,6 +286,7 @@ paths:
                         schema:
                             type: array
                             description: Details.
+                            nullable: true
                             example:
                             - first_name: 'John'
                               last_name: 'Doe'
@@ -310,4 +314,3 @@ tags:
     -
         name: Other<F0><9F><98><8E>
         description: ''
-

liverocaisson · 2024-05-22T01:34:34Z

@jfoliveira @shalvah
I have added your test but still dont pass
Maybe I made a mistake or still need to add some fixtures.

jfoliveira · 2024-05-27T12:20:42Z

@liverocaisson
It seems a few more changes were needed.
Could you please apply the diffs below into your branch and update this PR again?

1) File: `tests/Unit/OpenAPISpecWriterTest.php`

diff --git a/tests/Unit/OpenAPISpecWriterTest.php b/tests/Unit/OpenAPISpecWriterTest.php
index d5a20b17..7e6e77ce 100644
--- a/tests/Unit/OpenAPISpecWriterTest.php
+++ b/tests/Unit/OpenAPISpecWriterTest.php
@@ -403,6 +403,7 @@ class OpenAPISpecWriterTest extends TestCase
                                 'description' => 'Object array param',
                                 'example' => [[]],
                                 'type' => 'array',
+                                'nullable' => true,
                                 'items' => [
                                     'type' => 'object',
                                     'required' => ['field1'],
@@ -419,6 +420,7 @@ class OpenAPISpecWriterTest extends TestCase
                                             'type' => 'string',
                                             'description' => '',
                                             'example' => "hi",
+                                            'nullable' => true,
                                         ],
                                     ],
                                 ],

2) File: `tests/Fixtures/openapi.yaml`

diff --git a/tests/Fixtures/openapi.yaml b/tests/Fixtures/openapi.yaml
index 4ffc86bd..e4bedbbd 100644
--- a/tests/Fixtures/openapi.yaml
+++ b/tests/Fixtures/openapi.yaml
@@ -120,23 +120,23 @@ paths:
                     name: filters
                     description: 'The filters.'
                     example: consequatur
-                    nullable: true
                     required: false
                     schema:
                         type: string
                         description: 'The filters.'
                         example: consequatur
+                        nullable: true
                 -
                     in: query
                     name: url_encoded
                     description: 'Used for testing that URL parameters will be URL-encoded where needed.'
                     example: '+ []&='
-                    nullable: true
                     required: false
                     schema:
                         type: string
                         description: 'Used for testing that URL parameters will be URL-encoded where needed.'
                         example: '+ []&='
+                        nullable: true
                 -
                     in: header
                     name: Custom-Header
@@ -314,4 +314,3 @@ tags:
     -
         name: Other😎
         description: ''
-

jfoliveira · 2024-06-27T11:22:13Z

@liverocaisson It seems a few more changes were needed

Hey @liverocaisson
Could you apply those changes into your branch and update this PR?

jfoliveira · 2024-10-03T16:04:21Z

Hey @shalvah I see you're back to activity and merged #834 🎉
Could you also update/merge this PR, since @liverocaisson is no longer responding to comments here?

shalvah · 2024-10-18T19:42:42Z

I can try to resolve the conflicts, but it would be helpful if there was a clearer description of the PR's goal. Could you add an explanation?

[update] nullable Parameter For OpenApi3

31ee4ac

liverocaisson mentioned this pull request Oct 2, 2023

[need] Add nullable property to openapi.yml #668

Open

1 task

liverocaisson added 2 commits May 22, 2024 10:10

merge

31be418

[add] jfoliveira test fixtures

aa87f0b

liverocaisson mentioned this pull request May 22, 2024

feature/nullable #834

Merged

shalvah added the awaiting requester action label Nov 5, 2024

shalvah force-pushed the v4 branch from 1fe94e3 to 1ad707f Compare February 3, 2025 20:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

[update] nullable Parameter For OpenApi3#739

[update] nullable Parameter For OpenApi3#739
liverocaisson wants to merge 3 commits intoknuckleswtf:v4from
liverocaisson:feature/nullableParameterForOpenApi3

liverocaisson commented Oct 2, 2023

Uh oh!

shalvah commented Oct 2, 2023

Uh oh!

shalvah commented Nov 19, 2023

Uh oh!

jfoliveira commented May 16, 2024

Uh oh!

liverocaisson commented May 16, 2024

Uh oh!

jfoliveira commented May 16, 2024 •

edited

Loading

Uh oh!

liverocaisson commented May 22, 2024

Uh oh!

jfoliveira commented May 27, 2024

Uh oh!

jfoliveira commented Jun 27, 2024

Uh oh!

jfoliveira commented Oct 3, 2024

Uh oh!

shalvah commented Oct 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Comments

Conversation

liverocaisson commented Oct 2, 2023

Uh oh!

shalvah commented Oct 2, 2023

Uh oh!

shalvah commented Nov 19, 2023

Uh oh!

jfoliveira commented May 16, 2024

Uh oh!

liverocaisson commented May 16, 2024

Uh oh!

jfoliveira commented May 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

1) File: tests/Unit/OpenAPISpecWriterTest.php

2) File: tests/Fixtures/openapi.yaml

Uh oh!

liverocaisson commented May 22, 2024

Uh oh!

jfoliveira commented May 27, 2024

1) File: tests/Unit/OpenAPISpecWriterTest.php

2) File: tests/Fixtures/openapi.yaml

Uh oh!

jfoliveira commented Jun 27, 2024

Uh oh!

jfoliveira commented Oct 3, 2024

Uh oh!

shalvah commented Oct 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jfoliveira commented May 16, 2024 •

edited

Loading

1) File: `tests/Unit/OpenAPISpecWriterTest.php`

2) File: `tests/Fixtures/openapi.yaml`

1) File: `tests/Unit/OpenAPISpecWriterTest.php`

2) File: `tests/Fixtures/openapi.yaml`